deps(docs): [DREL-247] Update typedoc and typescript
#2552
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
teogeb
force-pushed
the
update-typedocs-0.25.13
branch
from
449773b to
fda47d3
Compare
teogeb
changed the base branch from
main
to
fix-setProxies-import-in-FakeNetworkNode
teogeb
force-pushed
the
update-typedocs-0.25.13
branch
from
fda47d3 to
ad89a63
Compare
teogeb
changed the title
typedoc and typescripttypedoc and typescript
teogeb
added a commit
that referenced
this pull request
Nov 15, 2024
Using `@remarks` tag instead of `@remark`. Was most likely a typo. TypeDoc supports only the tag as plural (https://typedoc.org/tags/remarks/). The unknown tag would trigger a warning when we update to latest TypeDoc (#2552).
Contributor
Author
|
Replaced by PR #2917 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updated TypeDoc, TypeScript and two related plugins.
With these changes Docusaurus seems to generate API documentation, but the output is not optimal. We should tweak it to look more like the output of the previous version (see the output generated in
mainbranch, or in https://docs.streamr.network/usage/sdk/api/)Changes / TODO
outdirectory definition has been updated. Maybe thedocs/prefix is needed now for some reason?refine-docs/index.js#110)refine-api-reference.tsfile (the functionality was moved torefine-docs/index.jsin Docs fix #1361)sidebars.jsconfig file, maybe it conflicts with that? (not clear if either of these configs is obsolete).refine-docsplugin is temporarily disabled. We should update some parts of the implementation (refine-docs/index.js) so that it is compatible with the current version.